Documentation
users

Cancel Subscription

delete
/v1/users/subscriptions/{id}
Cancel a subscription.
curl -X DELETE \
    'https://api.polar.sh/v1/users/subscriptions/00000000-0000-0000-0000-000000000000' \
    -H "Accept: application/json" \
    -H "Authorization: Bearer <token>" \
    
Responses
{
  "created_at": "2024-11-21T00:00:00.000Z",
  "modified_at": "2024-11-21T00:00:00.000Z",
  "id": "00000000-0000-0000-0000-000000000000",
  "amount": 0,
  "currency": "string",
  "recurring_interval": "month",
  "status": "incomplete",
  "current_period_start": "2024-11-21T00:00:00.000Z",
  "current_period_end": "2024-11-21T00:00:00.000Z",
  "cancel_at_period_end": false,
  "started_at": "2024-11-21T00:00:00.000Z",
  "ended_at": "2024-11-21T00:00:00.000Z",
  "user_id": "00000000-0000-0000-0000-000000000000",
  "product_id": "00000000-0000-0000-0000-000000000000",
  "price_id": "00000000-0000-0000-0000-000000000000",
  "discount_id": "00000000-0000-0000-0000-000000000000",
  "checkout_id": "00000000-0000-0000-0000-000000000000",
  "product": {
    "created_at": "2024-11-21T00:00:00.000Z",
    "modified_at": "2024-11-21T00:00:00.000Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string",
    "is_recurring": false,
    "is_archived": false,
    "organization_id": "00000000-0000-0000-0000-000000000000",
    "prices": [
      {
        "created_at": "2024-11-21T00:00:00.000Z",
        "modified_at": "2024-11-21T00:00:00.000Z",
        "id": "00000000-0000-0000-0000-000000000000",
        "amount_type": "fixed",
        "is_archived": false,
        "product_id": "00000000-0000-0000-0000-000000000000",
        "price_currency": "string",
        "price_amount": 0,
        "type": "recurring",
        "recurring_interval": "month"
      }
    ],
    "benefits": [
      {
        "created_at": "2024-11-21T00:00:00.000Z",
        "modified_at": "2024-11-21T00:00:00.000Z",
        "id": "00000000-0000-0000-0000-000000000000",
        "type": "custom",
        "description": "string",
        "selectable": false,
        "deletable": false,
        "organization_id": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "medias": [
      {
        "id": "00000000-0000-0000-0000-000000000000",
        "organization_id": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "path": "string",
        "mime_type": "string",
        "size": 0,
        "storage_version": "string",
        "checksum_etag": "string",
        "checksum_sha256_base64": "string",
        "checksum_sha256_hex": "string",
        "last_modified_at": "2024-11-21T00:00:00.000Z",
        "version": "string",
        "service": "product_media",
        "is_uploaded": false,
        "created_at": "2024-11-21T00:00:00.000Z",
        "size_readable": "string",
        "public_url": "string"
      }
    ],
    "organization": {
      "created_at": "2024-11-21T00:00:00.000Z",
      "modified_at": "2024-11-21T00:00:00.000Z",
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "slug": "string",
      "avatar_url": "string",
      "bio": "string",
      "company": "string",
      "blog": "string",
      "location": "string",
      "email": "string",
      "twitter_username": "string",
      "pledge_minimum_amount": 0,
      "pledge_badge_show_amount": false,
      "default_upfront_split_to_contributors": 0,
      "profile_settings": {
        "enabled": false,
        "description": "string",
        "featured_projects": [
          "00000000-0000-0000-0000-000000000000"
        ],
        "featured_organizations": [
          "00000000-0000-0000-0000-000000000000"
        ],
        "links": [
          "string"
        ],
        "subscribe": {
          "promote": false,
          "show_count": false,
          "count_free": false
        },
        "accent_color": "string"
      },
      "feature_settings": {
        "articles_enabled": false,
        "issue_funding_enabled": false
      }
    }
  },
  "price": {
    "created_at": "2024-11-21T00:00:00.000Z",
    "modified_at": "2024-11-21T00:00:00.000Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "amount_type": "fixed",
    "is_archived": false,
    "product_id": "00000000-0000-0000-0000-000000000000",
    "price_currency": "string",
    "price_amount": 0,
    "type": "recurring",
    "recurring_interval": "month"
  }
}